Implementation Notes
Gets the build information.
Gets the build information.
Creates (i.e. registers) business object data. You may pre-register business object data by setting the status to one of the pre-registration statuses (UPLOADING, PENDING_VALID, and PROCESSING).
Requires WRITE permission on namespace
Performs a search and returns a list of business object data key values and relative statuses for a range of requested business object data.
Requires READ permission on namespace
Performs an availability check for a collection of business object data.
Requires READ permission on ALL namespaces
Retrieves the DDL to initialize the specified type of the database system to perform queries for a range of requested business object data in the specified storage.
Requires READ permission on namespace
Retrieves the DDL to initialize the specified type of the database system to perform queries for a collection of business object data in the specified storage.
Requires READ permission on ALL namespaces
Retrieves existing business object data entry information.
NOTE: When both business object format version and business object data version are not specified, the business object format version has the precedence. The latest business object format version is determined by a sub-query, which does the following:
Requires READ permission on namespace
Deletes an existing business object data without subpartition values with namespace.
Requires WRITE permission on namespace
Deletes an existing business object data with 1 subpartition value with namespace.
Requires WRITE permission on namespace
Deletes an existing business object data with 2 subpartition values with namespace.
Requires WRITE permission on namespace
Deletes an existing business object data with 3 subpartition values with namespace
Requires WRITE permission on namespace
Deletes an existing business object data with 4 subpartition values with namespace.
Requires WRITE permission on namespace
Gets the S3 key prefix for writing or accessing business object data.
This endpoint requires a namespace.
Requires READ permission on namespace
Retrieves a list of existing business object data versions.
Requires READ permission on namespace
Initiates a restore request for a currently archived business object data.
Retries a storage policy transition by forcing re-initiation of the archiving process for the specified business object data that is still in progress of a valid archiving operation. This endpoint is designed to be run only after confirmation that the business object data is stuck due to an error during archiving.
Searches business object data based on namespace, definition name, format usage, file type, and format version.
Namespace and definition name are required.
Requires READ permission on namespace
Registers data as INVALID for objects which exist in S3 but are not registered in herd.
Requires WRITE permission on namespace
Creates a new business object data attribute.
Requires WRITE permission on namespace
Gets a list of keys for all existing business object data attributes for a specific business object data without subpartition values.
Requires READ permission on namespace
Deletes an existing attribute for the business object data without subpartition values.
Requires WRITE permission on namespace
Gets an existing attribute for the business object data without subpartition values.
Requires READ permission on namespace
Updates an existing attribute for the business object data without subpartition values.
Requires WRITE permission on namespace
Gets a list of keys for all existing business object data attributes for a specific business object data with 1 subpartition value.
Requires READ permission on namespace
Deletes an existing attribute for the business object data with 1 subpartition value.
Requires WRITE permission on namespace
Gets an existing attribute for the business object data with 1 subpartition values.
Requires READ permission on namespace
Updates an existing attribute for the business object data with 1 subpartition value.
Requires WRITE permission on namespace
Gets a list of keys for all existing business object data attributes for a specific business object data with 2 subpartition values.
Requires READ permission on namespace
Deletes an existing attribute for the business object data with 2 subpartition values.
Requires WRITE permission on namespace
Gets an existing attribute for the business object data with 2 subpartition values.
Requires READ permission on namespace
Updates an existing attribute for the business object data with 2 subpartition values.
Requires WRITE permission on namespace
Gets a list of keys for all existing business object data attributes for a specific business object data with 3 subpartition values.
Requires READ permission on namespace
Deletes an existing attribute for the business object data with 3 subpartition values.
Requires WRITE permission on namespace
Gets an existing attribute for the business object data with 3 subpartition values.
Requires READ permission on namespace
Updates an existing attribute for the business object data with 3 subpartition values.
Requires WRITE permission on namespace
Gets a list of keys for all existing business object data attributes for a specific business object data with 4 subpartition values.
Requires READ permission on namespace
Deletes an existing attribute for the business object data with 4 subpartition values.
Requires WRITE permission on namespace
Gets an existing attribute for the business object data with 4 subpartition values.
Requires READ permission on namespace
Updates an existing attribute for the business object data with 4 subpartition values.
Requires WRITE permission on namespace
Gets a list of keys for all existing business object data notification registrations that match the specified business object data notification filter parameters.
This endpoint requires both namespace and name of the business object definition.
Requires READ permission on business object definition namespace
Creates a new business object data notification.
Requires WRITE permission on namespace
Requires READ permission on filter namespace
Requires EXECUTE permission on ALL job action namespaces
Gets a list of keys for all existing business object data notification registrations for the specified business object data notification registration namespace.
Deletes an existing business object data notification by key.
Requires WRITE permission on namespace
Gets an existing business object data notification by key.
Requires READ permission on namespace
Updates an existing business object data notification by key.
Requires WRITE permission on namespace
Requires READ permission on filter namespace
Requires EXECUTE permission on ALL job action namespaces
Retrieves status information for an existing business object data.
Requires READ permission on namespace
Updates status of a business object data without subpartition values.
Requires WRITE permission on namespace
Updates status of a business object data with 1 subpartition values.
Requires WRITE permission on namespace
Updates status of a business object data with 2 subpartition values.
Requires WRITE permission on namespace
Updates status of a business object data with 3 subpartition values.
Requires WRITE permission on namespace
Updates status of a business object data with 4 subpartition values.
Requires WRITE permission on namespace
Creates new file(s) for a given business object data and storage.
Addition of storage files is only allowed for business object data with a pre-registration status.
Requires WRITE permission on namespace
Updates an existing business object definition descriptive information by key.
Requires no Namespace level security
Gets the list of business object definitions that are defined in the system.
Creates a new business object definition.
Requires WRITE permission on namespace
Index all business object definitions
Gets the list of business object definitions that are defined in the system.
Deletes an existing business object definition by key.
Requires WRITE permission on namespace
Gets an existing business object definition by key.
Updates an existing business object definition by key.
Requires WRITE permission on namespace
Searches across all business object definitions that are defined in the system per specified search filters and keys
Validate all business object definitions in the index
Creates a new business object definition column.
Gets a list of keys for all existing business object definition columns for a specific business object definition.
Deletes an existing column for the business object definition.
Gets an existing column for the business object definition.
Updates an existing column for the business object definition.
Retrieve a list of business object definition columns meeting the search criteria filters and fields request.
Creates a new business object definition subject matter expert.
Gets a list of keys for all existing business object definition subject matter experts for the specified business object definition.
Deletes an existing business object definition subject matter expert.
Creates a new business object definition tag.
Gets a list of keys for all existing business object definition tags that are associated with the specified business object definition.
Deletes an existing business object definition tag.
Gets a list of keys for all existing business object definition tags that are associated with the specified tag.
Creates a new business object format.
Requires WRITE permission on namespace
Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating a table for the requested business object format.
Requires READ permission on namespace
Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating tables for a collection of business object formats.
Requires READ permission on ALL namespaces
Gets a list of business object formats for the specified business object definition name.
Gets an existing business object format by alternate key.
Deletes an existing business format.
Requires WRITE permission on namespace
Updates an existing business object format by alternate key.
Requires WRITE permission on namespace
Gets all authorizations for the current user.
Creates a new custom DDL.
Requires WRITE permission on namespace
Gets a list of keys for all existing custom DDLs for a specific business object format.
Requires READ permission on namespace
Deletes an existing custom DDL.
Requires WRITE permission on namespace
Gets an existing custom DDL.
Requires READ permission on namespace
Updates an existing custom DDL.
Requires WRITE permission on namespace
Gets a list of data provider keys for all data providers defined in the system.
Creates a new data provider.
Deletes an existing data provider by data provider name.
Gets an existing data provider by data provider name.
Creates a new EMR cluster.
Requires EXECUTE permission on namespace
Gets an existing EMR cluster details.
Requires READ permission on namespace
Terminates an existing EMR cluster.
Requires EXECUTE permission on namespace
Adds a Hadoop Jar step to the existing cluster
Requires EXECUTE permission on namespace
Adds a hive step to the existing cluster
Requires EXECUTE permission on namespace
Adds security groups to the master node of an existing cluster
Requires WRITE permission on namespace
Adds a oozie step to the existing cluster
Requires EXECUTE permission on namespace
Submits an oozie workflow to the existing cluster.
Requires EXECUTE permission on namespace
Retrieves an existing Oozie workflow job for the specified EMR cluster and workflow job ID.
Requires READ permission on namespace
Adds a Pig step to the existing cluster
Requires EXECUTE permission on namespace
Adds a shell step to the existing cluster
Requires EXECUTE permission on namespace
Creates a new EMR cluster definition.
Requires WRITE permission on namespace
Gets a list of keys for all EMR cluster definitions defined in the system for the specified namespace.
Requires READ permission on namespace
Deletes an existing EMR cluster definition by namespace and name.
Requires WRITE permission on namespace
Gets an existing EMR cluster definition by namespace and name.
Requires READ permission on namespace
Updates an existing EMR cluster definition by namespace and name.
Requires WRITE permission on namespace
Deletes specified expected partition values from an existing partition key group which is identified by name.
Creates a list of expected partition values for an existing partition key group.
Retrieves a range of existing expected partition values.
Retrieves an existing expected partition value plus/minus an optional offset.
Gets a list of namespace keys for all namespaces defined in the system.
Gets a list of job executions based on the specified filter parameters.
Jobs' namespace to which you do not have READ permissions to will be omitted from the result.
Creates and starts a new job asynchronously.
Requires EXECUTE permission on namespace
Deletes a currently running job and preserves the job state in history.
Requires EXECUTE permission on namespace
Gets the details of a previously submitted job.
Requires READ permission on namespace
Activates or suspends a job execution.
Requires EXECUTE permission on namespace
Signals the job with the receive task.
Requires EXECUTE permission on namespace
Creates a new job definition.
Requires WRITE permission on namespace
Gets an existing job definition.
Requires READ permission on namespace
Updates an existing job definition.
Requires WRITE permission on namespace
Gets a list of namespace keys for all namespaces defined in the system.
Creates a new namespace.
Deletes an existing namespace by namespace code.
Gets an existing namespace by namespace code.
Get a list of namespace IAM role authorizations.
Authorizes a namespace to use IAM roles.
Removes IAM roles a namespace has authorizations to use.
Get the IAM roles that a namespace is authorized to use.
Sets the authorizations a namespace has to use IAM roles.
Updates the status of a notification registration.
Requires WRITE permission on namespace
Gets a list of all existing partition key groups.
Creates a new partition key group.
Deletes an existing partition key group by name.
Gets an existing partition key group by name.
Gets a list of namespace keys for all namespaces defined in the system.
Creates a new storage.
Deletes an existing storage by name.
Gets an existing storage by name.
Updates an existing storage.
Gets a list of existing storage platforms.
Gets an existing storage platform by name.
Creates a new storage policy.
Requires WRITE permission on namespace and READ permission on filter namespace
Gets an existing storage policy by key.
Requires READ permission on namespace
Updates an existing storage policy by key.
Requires WRITE permission on namespace and READ permission on filter namespace
Gets the AWS credential to download to the specified storage unit.
Requires READ permission on namespace
Gets the AWS credential to upload to the specified storage unit.
Requires WRITE permission on namespace
Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter parameters.
This endpoint requires both namespace and name of the business object definition.
Requires READ permission on business object definition namespace
Creates a new storage unit notification registration.
Requires WRITE permission on namespace
Requires READ permission on filter namespace
Requires EXECUTE permission on ALL job action namespaces
Gets a list of keys for all existing storage unit notification registrations for the specified storage unit notification registration namespace.
Deletes an existing storage unit notification registration by key.
Requires WRITE permission on namespace
Gets an existing storage unit notification registration by key.
Requires READ permission on namespace
Updates an existing storage unit notification registration by key.
Requires WRITE permission on namespace
Requires READ permission on filter namespace
Requires EXECUTE permission on ALL job action namespaces
Gets information for the specified subject matter expert.
Starts a system job asynchronously.
Creates a new tag.
Retrieves all tags existing in the system per specified search filters and keys. For each tag entity, this endpoint returns tag key by default along with any other top-level elements as specified by the "fields" query string parameter. The list of tags returned by this endpoint is sorted alphabetically by tag's display name ascending.
Retrieves all associated tags for the specified tag type code. When tagCode is null, return all tags of the tag type code, which has no parent (i.e. root tags). When tagCode is provided, return all tags of the tag type code and whose parent tag code is tagCode.
Deletes an existing tag.
Gets an existing tag.
Updates an existing tag.
Gets a list of tag type keys for all tag types defined in the system.
Creates a new tag type.
Deletes an existing tag type by tag type code.
Gets an existing tag type by tag type code.
Updates an existing tag type.
Retrieves all tag types existing in the system. For each tag type entity, the endpoint returns tag type key by default along with any other top-level elements as specified by the "fields" query string parameter. The list of tag types returned by the endpoint is sorted alphabetically by tag type's order value ascending.
Download a single business object definition sample file
Initiates a download of a single file.
Requires READ permission on namespace
Provide the location and credentials prior to upload a Sample Data file
Extends the credentials for a previously initiated upload.
Requires WRITE permission on namespace
Initiates a single file upload capability by creating the relative business object data instance in UPLOADING state and allowing write access to a specific location in S3_MANAGED_LOADING_DOCK storage.
Requires WRITE permission on namespace
Creates a new user namespace authorization.
The user ID field may be prefixed with a wildcard token character "" to authorize multiple users access to the namespace. The wildcard only works for as a prefix to match the suffix of the user ID. If the wildcard appears anywhere other than the prefix, the user ID must match as-is. For example:
Requires GRANT permission on namespace
Gets a list of user namespace authorizations for the specified namespace.
Gets a list of user namespace authorizations for the specified user.
Deletes an existing user namespace authorization by key.
Requires GRANT permission on namespace
Gets an existing user namespace authorization by key.
Requires READ permission on namespace
Updates an existing user namespace authorization by key.
Requires GRANT permission on namespace